Help/Extending and Customizing SC/Style Guide/ClassHelpTemplate.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="1038.25">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
  15 p.p6 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
  16 p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
  17 p.p8 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica}
  18 p.p9 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #bf0000}
  19 p.p10 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco}
  20 p.p11 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
  21 p.p12 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica; min-height: 17.0px}
  22 p.p13 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica; min-height: 14.0px}
  23 p.p14 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
  24 p.p15 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
  25 span.s1 {font: 18.0px Helvetica}
  26 span.s2 {color: #0000bf}
  27 span.s3 {color: #000000}
  28 span.s4 {color: #bf0000}
  29 span.s5 {font: 12.0px Helvetica; color: #000000}
  30 span.Apple-tab-span {white-space:pre}
  31 </style>
  32 </head>
  33 <body>
  34 <p class="p1"><span class="s1"><b>SomeClass<span class="Apple-tab-span">        </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b></span><b>explanation of what SomeClass is and/or does</b><span class="s1"><b><span class="Apple-tab-span">  </span></b></span></p>
  35 <p class="p2"><br></p>
  36 <p class="p1"><b>Inherits from: </b><a href="../../Core/Object.html"><span class="s2"><b>Object</b></span></a><b> : SuperClassOfSomeClass</b></p>
  37 <p class="p3"><br></p>
  38 <p class="p1">More detailed prose description of SomeClass.</p>
  39 <p class="p2"><br></p>
  40 <p class="p1"><b>See also:</b> <a href="../../ServerArchitecture/Server.html"><span class="s2">Server</span></a> [some other help files]</p>
  41 <p class="p2"><br></p>
  42 <p class="p4"><b>Some Important Issues Regarding SomeClass (optional)</b></p>
  43 <p class="p2"><br></p>
  44 <p class="p1">Explanation of the issues. For more information see <a href="../../ServerArchitecture/ServerTiming.html"><span class="s2">ServerTiming</span></a> and [some other help files].</p>
  45 <p class="p2"><br></p>
  46 <p class="p4"><b>Creation / Class Methods</b></p>
  47 <p class="p5"><br></p>
  48 <p class="p6"><b><span class="Apple-tab-span">  </span>*new(arg1, arg2)</b></p>
  49 <p class="p7"><b><span class="Apple-tab-span">  </span></b></p>
  50 <p class="p6"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>Short prose description of method.</p>
  51 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>arg1 </b>- Explanation of arg1 and its default value. Further important information regarding this method. Note the use of margins for effective text wrapping.</p>
  52 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>arg2<span class="Apple-converted-space"> </span></b> - Explanation of arg1 and its default value.<span class="Apple-tab-span">       </span><span class="Apple-tab-span">    </span></p>
  53 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  54 <p class="p9"><span class="s3"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// inline example</p>
  55 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>g = <span class="s2">SomeClass</span>.new;</p>
  56 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>g.doSomething; <span class="s4">// explanation</span></p>
  57 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>g.cleanUpMethod;</p>
  58 <p class="p5"><br></p>
  59 <p class="p6"><b><span class="Apple-tab-span">  </span>*aMethodWithNoArgs</b></p>
  60 <p class="p7"><b><span class="Apple-tab-span">  </span></b></p>
  61 <p class="p6"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>Short prose description of method.</p>
  62 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></p>
  63 <p class="p6">An optional short bit of prose explaining something important about the following class methods:</p>
  64 <p class="p5"><br></p>
  65 <p class="p6"><b><span class="Apple-tab-span">  </span>*anotherSimpleMethod(arg1)</b></p>
  66 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b></p>
  67 <p class="p6"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>This method does something to <b>arg1</b>.<span class="Apple-converted-space"> </span></p>
  68 <p class="p7"><br></p>
  69 <p class="p6"><b><span class="Apple-tab-span">  </span>*yetAnotherMethod</b></p>
  70 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b></p>
  71 <p class="p6"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>Short prose description.</p>
  72 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  73 <p class="p9"><span class="s5"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// inline example</p>
  74 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>g = <span class="s2">SomeClass</span>.new;</p>
  75 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>g.yetAnotherMethod; <span class="s4">// explanation</span></p>
  76 <p class="p10"><span class="s4"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>g.cleanUpMethod;</p>
  77 <p class="p7"><br></p>
  78 <p class="p11"><b>Accessing Instance and Class Variables</b></p>
  79 <p class="p7"><span class="Apple-tab-span">     </span></p>
  80 <p class="p6"><b><span class="Apple-tab-span">  </span>setSomeVar_(arg1)</b></p>
  81 <p class="p6"><b><span class="Apple-tab-span">  </span>getSomeVar</b></p>
  82 <p class="p7"><b><span class="Apple-tab-span">  </span></b><span class="Apple-tab-span">        </span></p>
  83 <p class="p6"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>Explanation including the type of <b>someVar </b>and a link to its help file.</p>
  84 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></p>
  85 <p class="p11"><b>Doing Some Task (optional)</b></p>
  86 <p class="p12"><br></p>
  87 <p class="p6">A short bit of prose explaining something about the task.</p>
  88 <p class="p7"><span class="Apple-tab-span">     </span></p>
  89 <p class="p6"><b><span class="Apple-tab-span">  </span>instanceMethod1(arg1)</b></p>
  90 <p class="p7"><b><span class="Apple-tab-span">  </span></b><span class="Apple-tab-span">        </span></p>
  91 <p class="p6"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>Explanation including default value for <b>arg1</b>.<span class="Apple-tab-span">        </span></p>
  92 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  93 <p class="p6"><span class="Apple-tab-span">     </span><b>instanceMethod2(arg1, arg2)</b></p>
  94 <p class="p7"><b><span class="Apple-tab-span">  </span></b><span class="Apple-tab-span">        </span></p>
  95 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>Explanation of this method.</p>
  96 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>arg1 </b>- Explanation and default value for arg1. Further important information regarding this method. Note the use of margins for effective text wrapping.</p>
  97 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>arg2<span class="Apple-converted-space"> </span></b> - Explanation of arg2 and its default value.<b><span class="Apple-tab-span">    </span></b></p>
  98 <p class="p13"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span">    </span></b></p>
  99 <p class="p8"><b><span class="Apple-tab-span">  </span>instanceMethodWithAReturnValue</b></p>
 100 <p class="p7"><b><span class="Apple-tab-span">  </span></b><span class="Apple-tab-span">        </span></p>
 101 <p class="p6"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>Returns a <a href="../../Math/Float.html"><span class="s2">Float</span></a> indicating... (explanation of the method)<span class="Apple-tab-span">       </span></p>
 102 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b></p>
 103 <p class="p6"><b><span class="Apple-tab-span">  </span>someInstanceMethod(aNode)</b></p>
 104 <p class="p6"><b><span class="Apple-tab-span">  </span>someInstanceMethodMsg(aNode)</b></p>
 105 <p class="p7"><b><span class="Apple-tab-span">  </span></b></p>
 106 <p class="p6"><b><span class="Apple-tab-span">  </span></b><span class="Apple-tab-span">        </span>Explanation of these two closely related methods.<span class="Apple-tab-span">   </span></p>
 107 <p class="p2"><br></p>
 108 <p class="p11"><b>Examples</b></p>
 109 <p class="p3"><br></p>
 110 <p class="p14">// what this example does</p>
 111 <p class="p15">g = <span class="s2">SomeClass</span>.new;</p>
 112 <p class="p15">g.instanceMethod(someObject);</p>
 113 <p class="p15">g.cleanUp;</p>
 114 <p class="p3"><br></p>
 115 <p class="p15">...</p>
 116 </body>
 117 </html>